home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / options.n < prev    next >
Text File  |  1994-09-20  |  23KB  |  765 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/options.n,v 1.15 93/08/18 12:09:27 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS options tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. options \- Standard options supported by widgets
  210. .BE
  211.  
  212. .SH DESCRIPTION
  213. This manual entry describes the common configuration options supported
  214. by widgets in the Tk toolkit.  Every widget does not necessarily support
  215. every option (see the manual entries for individual widgets for a list
  216. of the standard options supported by that widget), but if a widget does
  217. support an option with one of the names listed below, then the option
  218. has exactly the effect described below.
  219. .PP
  220. In the descriptions below,
  221. ``Name'' refers to the option's name in the option database (e.g.
  222. in .Xdefaults files).  ``Class'' refers to the option's class value
  223. in the option database.  ``Command-Line Switch'' refers to the
  224. switch used in widget-creation and \fBconfigure\fR widget commands to
  225. set this value.  For example, if an option's command-line switch is
  226. \fB\-foreground\fR and there exists a widget \fB.a.b.c\fR, then the
  227. command
  228. .DS
  229. \&\fB.a.b.c\0\0configure\0\0\-foreground black\fR
  230. .DE
  231. may be used to specify the value \fBblack\fR for the option in the
  232. the widget \fB.a.b.c\fR.  Command-line switches may be abbreviated,
  233. as long as the abbreviation is unambiguous.
  234. .ta 4c
  235. .LP
  236. .nf
  237. Name:    \fBactiveBackground\fR
  238. Class:    \fBForeground\fR
  239. Command-Line Switch:    \fB\-activebackground\fR
  240. .fi
  241. .IP
  242. Specifies background color to use when drawing active elements.
  243. An element (a widget or portion of a widget) is active if the
  244. mouse cursor is positioned over the element and pressing a mouse button
  245. will cause some action to occur.
  246. .LP
  247. .nf
  248. Name:    \fBactiveBorderWidth\fR
  249. Class:    \fBBorderWidth\fR
  250. Command-Line Switch:    \fB\-activeborderwidth\fR
  251. .fi
  252. .IP
  253. Specifies a non-negative value indicating
  254. the width of the 3-D border drawn around active elements.  See above for
  255. definition of active elements.
  256. .VS
  257. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  258. .VE
  259. This option is typically only available in widgets displaying more
  260. than one element at a time (e.g. menus but not buttons).
  261. .LP
  262. .nf
  263. Name:    \fBactiveForeground\fR
  264. Class:    \fBBackground\fR
  265. Command-Line Switch:    \fB\-activeforeground\fR
  266. .fi
  267. .IP
  268. Specifies foreground color to use when drawing active elements.
  269. See above for definition of active elements.
  270. .LP
  271. .nf
  272. .VS
  273. Name:    \fBanchor\fR
  274. Class:    \fBAnchor\fR
  275. Command-Line Switch:    \fB\-anchor\fR
  276. .fi
  277. .IP
  278. Specifies how the information in a widget (e.g. text or a bitmap)
  279. is to be displayed in the widget.
  280. Must be one of the values \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR,
  281. \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR.
  282. For example, \fBnw\fR means display the information such that its
  283. top-left corner is at the top-left corner of the widget.
  284. .VE
  285. .LP
  286. .nf
  287. Name:    \fBbackground\fR
  288. Class:    \fBBackground\fR
  289. Command-Line Switch:    \fB\-background or \-bg\fR
  290. .fi
  291. .IP
  292. Specifies the normal background color to use when displaying the
  293. widget.
  294. .LP
  295. .nf
  296. Name:    \fBbitmap\fR
  297. .VS
  298. Class:    \fBBitmap\fR
  299. Command-Line Switch:    \fB\-bitmap\fR
  300. .fi
  301. .IP
  302. Specifies a bitmap to display in the widget, in any of the forms
  303. acceptable to \fBTk_GetBitmap\fR.
  304. The exact way in which the bitmap is displayed may be affected by
  305. other options such as \fBanchor\fR or \fBjustify\fR.
  306. Typically, if this option is specified then it overrides other
  307. options that specify a textual value to display in the widget;
  308. the \fBbitmap\fR option may be reset to an empty string to re-enable
  309. a text display.
  310. .VE
  311. .LP
  312. .nf
  313. Name:    \fBborderWidth\fR
  314. Class:    \fBBorderWidth\fR
  315. Command-Line Switch:    \fB\-borderwidth or \-bd\fR
  316. .fi
  317. .IP
  318. Specifies a non-negative value indicating the width
  319. of the 3-D border to draw around the outside of the widget (if such a
  320. border is being drawn;  the \fBrelief\fR option typically determines
  321. this).  The value may also be used when drawing 3-D effects in the
  322. interior of the widget.
  323. .VS
  324. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  325. .VE
  326. .LP
  327. .nf
  328. Name:    \fBcursor\fR
  329. Class:    \fBCursor\fR
  330. Command-Line Switch:    \fB\-cursor\fR
  331. .fi
  332. .IP
  333. Specifies the mouse cursor to be used for the widget.
  334. The value may have any of the forms acceptable to \fBTk_GetCursor\fR.
  335. .LP
  336. .nf
  337. Name:    \fBcursorBackground\fR
  338. Class:    \fBForeground\fR
  339. Command-Line Switch:    \fB\-cursorbackground\fR
  340. .fi
  341. .IP
  342. Specifies the color to use as background in the area covered by the
  343. insertion cursor.  This color will normally override either the normal
  344. background for the widget (or the selection background if the insertion
  345. cursor happens to fall in the selection).
  346. .VS
  347. \fIThis option is obsolete and is gradually being replaced by
  348. the \fBinsertBackground\fR option.\fR
  349. .VE
  350. .LP
  351. .nf
  352. Name:    \fBcursorBorderWidth\fR
  353. Class:    \fBBorderWidth\fR
  354. Command-Line Switch:    \fB\-cursorborderwidth\fR
  355. .fi
  356. .IP
  357. Specifies a non-negative value indicating the width
  358. of the 3-D border to draw around the insertion cursor.
  359. .VS
  360. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  361. \fIThis option is obsolete and is gradually being replaced by
  362. the \fBinsertBorderWidth\fR option.\fR
  363. .VE
  364. .LP
  365. .nf
  366. Name:    \fBcursorOffTime\fR
  367. Class:    \fBOffTime\fR
  368. Command-Line Switch:    \fB\-cursorofftime\fR
  369. .fi
  370. .IP
  371. Specifies a non-negative integer value indicating the number of
  372. milliseconds the cursor should remain ``off'' in each blink cycle.
  373. If this option is zero then the cursor doesn't blink:  it is on
  374. all the time.
  375. .VS
  376. \fIThis option is obsolete and is gradually being replaced by
  377. the \fBinsertOffTime\fR option.\fR
  378. .VE
  379. .LP
  380. .nf
  381. Name:    \fBcursorOnTime\fR
  382. Class:    \fBOnTime\fR
  383. Command-Line Switch:    \fB\-cursorontime\fR
  384. .fi
  385. .IP
  386. Specifies a non-negative integer value indicating the number of
  387. milliseconds the cursor should remain ``on'' in each blink cycle.
  388. .VS
  389. \fIThis option is obsolete and is gradually being replaced by
  390. the \fBinsertOnTime\fR option.\fR
  391. .VE
  392. .LP
  393. .nf
  394. Name:    \fBcursorWidth\fR
  395. Class:    \fBCursorWidth\fR
  396. Command-Line Switch:    \fB\-cursorwidth\fR
  397. .fi
  398. .IP
  399. Specifies a  value indicating the total width of the insertion cursor.
  400. .VS
  401. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  402. .VE
  403. If a border has been specified for
  404. the cursor (using the \fBcursorBorderWidth\fR option), the border
  405. will be drawn inside the width specified by the \fBcursorWidth\fR
  406. option.
  407. .VS
  408. \fIThis option is obsolete and is gradually being replaced by
  409. the \fBinsertWidth\fR option.\fR
  410. .VE
  411. .LP
  412. .nf
  413. .VS
  414. Name:    \fBdisabledForeground\fR
  415. Class:    \fBDisabledForeground\fR
  416. Command-Line Switch:    \fB\-disabledforeground\fR
  417. .fi
  418. .IP
  419. Specifies foreground color to use when drawing a disabled element.
  420. If the option is specified as an empty string (which is typically the
  421. case on monochrome displays), disabled elements are drawn with the
  422. normal fooreground color but they are dimmed by drawing them
  423. with a stippled fill pattern.
  424. .VE
  425. .LP
  426. .nf
  427. .VS
  428. Name:    \fBexportSelection\fR
  429. Class:    \fBExportSelection\fR
  430. Command-Line Switch:    \fB\-exportselection\fR
  431. .fi
  432. .IP
  433. Specifies whether or not a selection in the widget should also be
  434. the X selection.
  435. The value may have any of the forms accepted by \fBTcl_GetBoolean\fR,
  436. such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR, \fByes\fR, or \fBno\fR.
  437. If the selection is exported, then selecting in the widget deselects
  438. the current X selection, selecting outside the widget deselects any
  439. widget selection, and the widget will respond to selection retrieval
  440. requests when it has a selection.  The default is usually for widgets
  441. to export selections.
  442. .VE
  443. .LP
  444. .nf
  445. Name:    \fBfont\fR
  446. Class:    \fBFont\fR
  447. Command-Line Switch:    \fB\-font\fR
  448. .fi
  449. .IP
  450. Specifies the font to use when drawing text inside the widget.
  451. .LP
  452. .nf
  453. Name:    \fBforeground\fR
  454. Class:    \fBForeground\fR
  455. Command-Line Switch:    \fB\-foreground or \-fg\fR
  456. .fi
  457. .IP
  458. Specifies the normal foreground color to use when displaying the widget.
  459. .LP
  460. .nf
  461. Name:    \fBgeometry\fR
  462. Class:    \fBGeometry\fR
  463. Command-Line Switch:    \fB\-geometry\fR
  464. .fi
  465. .IP
  466. Specifies the desired geometry for the widget's window, in the
  467. form \fIwidth\fBx\fIheight\fR, where \fIwidth\fR is the desired
  468. width of the window and \fIheight\fR is the desired height.  The
  469. units for \fIwidth\fR and \fIheight\fR depend on the particular
  470. widget.  For widgets displaying text the units are usually the
  471. size of the characters in the font being displayed;  for other
  472. widgets the units are usually pixels.
  473. .LP
  474. .nf
  475. .VS
  476. Name:    \fBinsertBackground\fR
  477. Class:    \fBForeground\fR
  478. Command-Line Switch:    \fB\-insertbackground\fR
  479. .fi
  480. .IP
  481. Specifies the color to use as background in the area covered by the
  482. insertion cursor.  This color will normally override either the normal
  483. background for the widget (or the selection background if the insertion
  484. cursor happens to fall in the selection).
  485. .LP
  486. .nf
  487. Name:    \fBinsertBorderWidth\fR
  488. Class:    \fBBorderWidth\fR
  489. Command-Line Switch:    \fB\-insertborderwidth\fR
  490. .fi
  491. .IP
  492. Specifies a non-negative value indicating the width
  493. of the 3-D border to draw around the insertion cursor.
  494. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  495. .LP
  496. .nf
  497. Name:    \fBinsertOffTime\fR
  498. Class:    \fBOffTime\fR
  499. Command-Line Switch:    \fB\-insertofftime\fR
  500. .fi
  501. .IP
  502. Specifies a non-negative integer value indicating the number of
  503. milliseconds the insertion cursor should remain ``off'' in each blink cycle.
  504. If this option is zero then the cursor doesn't blink:  it is on
  505. all the time.
  506. .LP
  507. .nf
  508. Name:    \fBinsertOnTime\fR
  509. Class:    \fBOnTime\fR
  510. Command-Line Switch:    \fB\-insertontime\fR
  511. .fi
  512. .IP
  513. Specifies a non-negative integer value indicating the number of
  514. milliseconds the insertion cursor should remain ``on'' in each blink cycle.
  515. .LP
  516. .nf
  517. Name:    \fBinsertWidth\fR
  518. Class:    \fBInsertWidth\fR
  519. Command-Line Switch:    \fB\-insertwidth\fR
  520. .fi
  521. .IP
  522. Specifies a  value indicating the total width of the insertion cursor.
  523. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  524. If a border has been specified for the insertion
  525. cursor (using the \fBinsertBorderWidth\fR option), the border
  526. will be drawn inside the width specified by the \fBinsertWidth\fR
  527. option.
  528. .VE
  529. .LP
  530. .nf
  531. Name:    \fBorient\fR
  532. Class:    \fBOrient\fR
  533. Command-Line Switch:    \fB\-orient\fR
  534. .fi
  535. .IP
  536. For widgets that can lay themselves out with either a horizontal
  537. or vertical orientation, such as scrollbars, this option specifies
  538. which orientation should be used.  Must be either \fBhorizontal\fR
  539. or \fBvertical\fR or an abbreviation of one of these.
  540. .LP
  541. .nf
  542. Name:    \fBpadX\fR
  543. Class:    \fBPad\fR
  544. Command-Line Switch:    \fB\-padx\fR
  545. .fi
  546. .IP
  547. Specifies a non-negative value indicating how much extra space
  548. to request for the widget in the X-direction.
  549. .VS
  550. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  551. .VE
  552. When computing how large a window it needs, the widget will
  553. add this amount to the width it would normally need (as determined
  554. by the width of the things displayed in the widget);  if the geometry
  555. manager can satisfy this request, the widget will end up with extra
  556. internal space to the left and/or right of what it displays inside.
  557. .LP
  558. .nf
  559. Name:    \fBpadY\fR
  560. Class:    \fBPad\fR
  561. Command-Line Switch:    \fB\-pady\fR
  562. .fi
  563. .IP
  564. Specifies a non-negative value indicating how much extra space
  565. to request for the widget in the Y-direction.
  566. .VS
  567. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  568. .VE
  569. When computing how large a window it needs, the widget will add
  570. this amount to the height it would normally need (as determined by
  571. the height of the things displayed in the widget);  if the geometry
  572. manager can satisfy this request, the widget will end up with extra
  573. internal space above and/or below what it displays inside.
  574. .LP
  575. .nf
  576. Name:    \fBrelief\fR
  577. Class:    \fBRelief\fR
  578. Command-Line Switch:    \fB\-relief\fR
  579. .fi
  580. .IP
  581. Specifies the 3-D effect desired for the widget.  Acceptable
  582. .VS
  583. values are \fBraised\fR, \fBsunken\fR, \fBflat\fR, \fBridge\fR,
  584. and \fBgroove\fR.
  585. .VE
  586. The value
  587. indicates how the interior of the widget should appear relative
  588. to its exterior;  for example, \fBraised\fR means the interior of
  589. the widget should appear to protrude from the screen, relative to
  590. the exterior of the widget.
  591. .LP
  592. .nf
  593. Name:    \fBrepeatDelay\fR
  594. Class:    \fBRepeatDelay\fR
  595. Command-Line Switch:    \fB\-repeatdelay\fR
  596. .fi
  597. .IP
  598. Specifies the number of milliseconds a button or key must be held
  599. down before it begins to auto-repeat.  Used, for example, on the
  600. up- and down-arrows in scrollbars.
  601. .LP
  602. .nf
  603. Name:    \fBrepeatInterval\fR
  604. Class:    \fBRepeatInterval\fR
  605. Command-Line Switch:    \fB\-repeatinterval\fR
  606. .fi
  607. .IP
  608. Used in conjunction with \fBrepeatDelay\fR:  once auto-repeat
  609. begins, this option determines the number of milliseconds between
  610. auto-repeats.
  611. .LP
  612. .nf
  613. Name:    \fBscrollCommand\fR
  614. Class:    \fBScrollCommand\fR
  615. Command-Line Switch:    \fB\-scrollcommand\fR
  616. .fi
  617. .IP
  618. Specifies the prefix for a command used to communicate with scrollbar
  619. widgets.  When the view in the widget's window changes (or
  620. whenever anything else occurs that could change the display in a
  621. scrollbar, such as a change in the total size of the widget's
  622. contents), the widget will
  623. generate a Tcl command by concatenating the scroll command and four
  624. numbers.  The four numbers are, in order:  the total size of the
  625. widget's contents, in unspecified units
  626. (``unit'' is a widget-specific term;  for widgets
  627. displaying text, the unit is a line);  the maximum number of units that
  628. may be displayed at once in the widget's window, given its current size;  the
  629. index of the top-most or left-most unit currently visible in the window
  630. (index 0 corresponds to the first unit); and the index of the bottom-most
  631. or right-most unit currently visible in the window.  This command is
  632. then passed to the Tcl interpreter for execution.  Typically the
  633. \fBscrollCommand\fR option consists of the path name of a scrollbar
  634. widget followed by ``set'', e.g. ``.x.scrollbar set'':  this will cause
  635. the scrollbar to be updated whenever the view in the window changes.
  636. If this option is not specified, then no command will be executed.
  637. .IP
  638. .VS
  639. The \fBscrollCommand\fR option is used for widgets that support scrolling
  640. in only one direction.
  641. For widgets that support scrolling in both directions, this
  642. option is replaced with the \fBxScrollCommand\fR and \fByScrollCommand\fR
  643. options.
  644. .VE
  645. .LP
  646. .nf
  647. Name:    \fBselectBackground\fR
  648. Class:    \fBForeground\fR
  649. Command-Line Switch:    \fB\-selectbackground\fR
  650. .fi
  651. .IP
  652. Specifies the background color to use when displaying selected
  653. items.
  654. .LP
  655. .nf
  656. Name:    \fBselectBorderWidth\fR
  657. Class:    \fBBorderWidth\fR
  658. Command-Line Switch:    \fB\-selectborderwidth\fR
  659. .fi
  660. .IP
  661. Specifies a non-negative value indicating the width
  662. of the 3-D border to draw around selected items.
  663. .VS
  664. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  665. .VE
  666. .LP
  667. .nf
  668. Name:    \fBselectForeground\fR
  669. Class:    \fBBackground\fR
  670. Command-Line Switch:    \fB\-selectforeground\fR
  671. .fi
  672. .IP
  673. Specifies the foreground color to use when displaying selected
  674. items.
  675. .LP
  676. .nf
  677. .VS
  678. Name:    \fBsetGrid\fR
  679. Class:    \fBSetGrid\fR
  680. Command-Line Switch:    \fB\-setgrid\fR
  681. .fi
  682. .IP
  683. Specifies a boolean value that determines whether this widget controls the
  684. resizing grid for its top-level window.
  685. This option is typically used in text widgets, where the information
  686. in the widget has a natural size (the size of a character) and it makes
  687. sense for the window's dimensions to be integral numbers of these units.
  688. These natural window sizes form a grid.
  689. If the \fBsetGrid\fR option is set to true then the widget will
  690. communicate with the window manager so that when the user interactively
  691. resizes the top-level window that contains the widget, the dimensions of
  692. the window will be displayed to the user in grid units and the window
  693. size will be constrained to integral numbers of grid units.
  694. See the section GRIDDED GEOMETRY MANAGEMENT in the \fBwm\fR manual
  695. entry for more details.
  696. .VE
  697. .LP
  698. .nf
  699. Name:    \fBtext\fR
  700. Class:    \fBText\fR
  701. Command-Line Switch:    \fB\-text\fR
  702. .fi
  703. .IP
  704. Specifies a string to be displayed inside the widget.  The way in which
  705. the string is displayed depends on the particular widget and may be
  706. determined by other options, such as \fBanchor\fR or \fBjustify\fR.
  707. .LP
  708. .nf
  709. .VS
  710. Name:    \fBtextVariable\fR
  711. Class:    \fBVariable\fR
  712. Command-Line Switch:    \fB\-textvariable\fR
  713. .fi
  714. .IP
  715. Specifies the name of a variable.  The value of the variable is a text
  716. string to be displayed inside the widget;  if the variable value changes
  717. then the widget will automatically update itself to reflect the new value.
  718. The way in which the string is displayed in the widget depends on the
  719. particular widget and may be determined by other options, such as
  720. \fBanchor\fR or \fBjustify\fR.
  721. .LP
  722. .nf
  723. Name:    \fBunderline\fR
  724. Class:    \fBUnderline\fR
  725. Command-Line Switch:    \fB\-underline\fR
  726. .fi
  727. .IP
  728. Specifies the integer index of a character to underline in the widget.
  729. This option is typically used to indicate keyboard traversal characters
  730. in menu buttons and menu entries.  0 corresponds to the first character
  731. of the text displayed in the widget, 1 to the next character, and so
  732. on.
  733. .LP
  734. .nf
  735. Name:    \fBxScrollCommand\fR
  736. Class:    \fBScrollCommand\fR
  737. Command-Line Switch:    \fB\-xscrollcommand\fR
  738. .fi
  739. .IP
  740. Specifies the prefix for a command used to communicate with horizontal
  741. scrollbars.  This option is treated in the same way as the
  742. \fBscrollCommand\fR option, except that it is used for horizontal
  743. scrollbars associated with widgets that support both horizontal
  744. and vertical scrolling.
  745. See the description of \fBscrollCommand\fR for complete details
  746. on how this option is used.
  747. .LP
  748. .nf
  749. Name:    \fByScrollCommand\fR
  750. Class:    \fBScrollCommand\fR
  751. Command-Line Switch:    \fB\-yscrollcommand\fR
  752. .fi
  753. .IP
  754. Specifies the prefix for a command used to communicate with vertical
  755. scrollbars.  This option is treated in the same way as the
  756. \fBscrollCommand\fR option, except that it is used for vertical
  757. scrollbars associated with widgets that support both horizontal
  758. and vertical scrolling.
  759. See the description of \fBscrollCommand\fR for complete details
  760. on how this option is used.
  761. .VE
  762.  
  763. .SH KEYWORDS
  764. class, name, standard option, switch
  765.